home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / comm2 / wcview1.zip / WCVIEW.DOC < prev    next >
Text File  |  1993-01-29  |  15KB  |  337 lines
  1.  
  2.  
  3.  
  4.  
  5.                              WCView V1.00
  6.  
  7.                  WILDCAT! V3.xx @Code Screen File Viewer
  8.            featuring: User-Definable @Variable Replacement Text
  9.  
  10.  
  11.             Program & this document Copyright 1993, Jeff Sloan
  12.         WILDCAT! is a registered trademark of Mustang Software, Inc.
  13.  
  14.                         Last Updated: 29 JAN 1993
  15.  
  16.                             Yardbird Software
  17.                               P.O. Box 4646
  18.                            West Hills, CA 91308
  19.  
  20.                               (818)704-6402
  21.                           CompuServe: 73650,104
  22.  
  23.                           _______
  24.                      ____|__     |               (R)
  25.                   --|       |    |-------------------
  26.                     |   ____|__  |  Association of
  27.                     |  |       |_|  Shareware
  28.                     |__|   o   |    Professionals
  29.                   -----|   |   |---------------------
  30.                        |___|___|    MEMBER
  31.  
  32.  
  33.  
  34.     Acknowledgments
  35.  
  36.         The author wishes to thank all the beta testers for their
  37.     contribution towards making this program as bug-free as possible.
  38.     Special thanks goes to Dave Jackson for originally suggesting the
  39.     idea for this program, and his many helpful ideas and encouragement
  40.     during it's development. 
  41.  
  42.  
  43.  
  44.     WHAT IS WCView?
  45.  
  46.         WCView is a DESQview-aware screen viewer for WILDCAT! 3.xx
  47.     @code screen files.  In addition to displaying screens using the
  48.     specified colors, any user or system @variables embedded in the
  49.     screens will be replaced with text, simulating exactly how your
  50.     screens will look to your BBS callers on-line.  The default
  51.     @variable replacement text is kept in a separate text file:
  52.     WCVIEW.VAR which may be customized to your specifications using a
  53.     text editor.  Single screens can be displayed, or you may enter
  54.     multiple screen filenames on the command line, or even use DOS
  55.     wild cards to display a series of screens one after another.
  56.         WCView is a great companion program to the Laughing Dog Screen
  57.     Maker, Yardbird Software's premiere BBS screen designer.  Of course,
  58.     WCView will work with any WILDCAT! 3.xx. screen files, but if you
  59.     aren't using the Laughing Dog to create your screens, you are
  60.     definitely working too hard!
  61.  
  62.  
  63.  
  64.     INSTALLING WCVIEW:
  65.     
  66.          To install WCView, simply copy the WCVIEW.EXE file and it's
  67.     @variable file: WCVIEW.VAR into the same subdirectory on your hard
  68.     disk, or a floppy disk.
  69.          The WCVIEW.VAR file MUST reside in the same directory as
  70.     WCVIEW.EXE in order to replace any @variables with the default, or
  71.     your own custom replacement text.  You may install these two files
  72.     in a directory that is in your AUTOEXEC.BAT PATH in order to allow
  73.     you to easily view files from any location on your disk.
  74.  
  75.     NOTE: If WCView cannot find the WCVIEW.VAR file, you will be
  76.     notified of this and given the choice of either quitting the program
  77.     immediately, or continuing to view the file(s) without the
  78.     replacement text (in which case, the literal @variable strings,
  79.     @USER@, @DATE@, etc., will be displayed as is).
  80.  
  81.  
  82.     RUNNING WCVIEW.EXE
  83.     
  84.     Command-Line USAGE:
  85.  
  86.          WCVIEW [? | /?] [/Mbf] [/Dn] [filename.ext] [filename.ext ...]
  87.  
  88.                                                (DOS wild cards OK)
  89.      >>   ? or /?
  90.     Either of these by themselves after WCVIEW will display a help
  91.     screen.
  92.  
  93.  
  94.       >>   /Mbf
  95.     This allows you to override the default attribute (Lightgray on Black)
  96.     used for monochrome when toggling the displayed screens between full
  97.     color and monochrome (see Commands Available During File Display,
  98.     below)
  99.  
  100.         b = the upper case hex value for the background color
  101.         f = the upper case hex value for the foreground color
  102.  
  103.     Possible values are:
  104.     ---------------------------------------------
  105.        Background               Foreground
  106.     ---------------------------------------------
  107.     0 = Black                0 = Black
  108.     1 = Blue                 1 = Blue
  109.     2 = Green                2 = Green
  110.     3 = Cyan                 3 = Cyan
  111.     4 = Red                  4 = Red
  112.     5 = Magenta              5 = Magenta
  113.     6 = Brown                6 = Brown
  114.     7 = Lightgray            7 = Lightgray
  115.     8 = Black, blinking      8 = Darkgray
  116.     9 = Blue, blinking       9 = Light Blue
  117.     A = Green, blinking      A = Light Green
  118.     B = Cyan, blinking       B = Light Cyan
  119.     C = Red, blinking        C = Light Red
  120.     D = Magenta, blinking    D = Light Magenta
  121.     E = Brown, blinking      E = Yellow
  122.     F = Lightgray, blinking  F = White
  123.  
  124.     example:    /M1E = Yellow on Blue
  125.  
  126.     You also may change the monochrome attribute in the middle of a series of
  127.     files that were listed on the command line to display as a group.
  128.     For instance:
  129.  
  130.     WCVIEW /M1E title.bbs menu1.bbs /M0E goodbye.bbs
  131.  
  132.  
  133.       >>  /Dn
  134.     This allows you to change the speed at which the files are displayed on
  135.     your screen. The default delay is 0.
  136.     Replace the n above with any value from 1-9 to change the initial delay.
  137.        0 = No delay
  138.        9 = Maximum delay
  139.  
  140.  
  141.      >>   filename.ext
  142.     One filename with it's extension will display that one file, wait
  143.     for a keystroke, then exit.
  144.  
  145.  
  146.      >>   file1.ext file2.ext file3.ext ...
  147.     More than one filename.ext (each separated by a space) will display
  148.     each file in order, one after the other.  This allows you to do
  149.     things like simulate a users progression through a series of menus
  150.     and screens by placing those screen file names, in the correct
  151.     order, on the command line (or in a batch file).
  152.  
  153.  
  154.      >>   filenames using the DOS wild card chars: '*' and '?'
  155.     Using DOS wild card character expressions like: *.*, *.BBS,
  156.     file??.BBS, A*.*, etc. will cause all files in the current directory
  157.     (or a specified directory, example: C:\WC\SCREENS\*.BBS) to be
  158.     displayed in the order in which DOS finds them, one after another.
  159.  
  160.     NOTE: If WCView cannot find a file, or has a problem opening the
  161.     file, it will display an error message, then attempt to continue, if
  162.     possible.
  163.  
  164.     ALSO NOTE: WCView will attempt to display any file you hand it on
  165.     the command line, even if that file is not an actual @code file, it
  166.     doesn't care!
  167.  
  168.  
  169.     COMMANDS AVAILABLE DURING FILE DISPLAY
  170.  
  171.          Whenever a file is longer than the current number of lines
  172.     available on your monitor minus one (for the status line), for
  173.     instance screens longer than 24 lines when in 25 line mode, the
  174.     familiar:
  175.     
  176.     -Pause- [C]ontinue,[N]onStop,[S]top? [C]
  177.  
  178.     will be displayed at the bottom of the screen, there is also some
  179.     additional information displayed, however, which does not normally
  180.     appear in WILDCAT! so your status line will actually look something
  181.     like this:
  182.  
  183.     -Pause- [C]ontinue,[N]onStop,[S]top,Delay[0-9]? [C]  Screen1: my.bbs
  184.  
  185.          The name of the screen (my.bbs) and an indication of the
  186.     screen's position in a list of multiple screen files (Screen1:) is
  187.     displayed at the far right end of the line.  This is useful  if you
  188.     ran the program with several screen files or wild cards specified on
  189.     the command line, to remind you exactly which file you are currently
  190.     viewing.
  191.          There is also another option: "Delay[0-9]" available.  This
  192.     controls the speed at which the file is displayed on your screen.
  193.     The default is Delay=0, or full speed.  You may choose to display
  194.     the screen at a reduced speed by pressing one of the number keys on
  195.     your keyboard between 1 and 9 for varying delays between lines.
  196.     Pressing "0" will return the display to the minimum delay (maximum
  197.     speed) setting.  These number keys may be pressed at any time during
  198.     display, not just in response to the -Pause- prompt.
  199.          Pressing the Spacebar at any time will cause an immediate Pause
  200.     to occur.
  201.          Pressing the "N" key will have the usual effect of letting the
  202.     entire screen scroll past without pauses.
  203.          Pressing "S" will immediately stop all scrolling, and exit the
  204.     WCView program, leaving the display intact (without clearing the
  205.     screen).
  206.          Pressing "C" (or any other key) will simply continue the normal
  207.     display of the screen.
  208.          Pressing <ESC> will immediately exit the program and clear the
  209.     screen.
  210.  
  211.          If the screen being displayed contains any of the display
  212.     control codes (@PAUSE@, @NOPAUSE@, @STOP@, @NOSTOP@, or @CLS@)
  213.     embedded in it, those controls will override anything typed in
  214.     response to an on-screen prompt, as they would on-line.
  215.  
  216.     
  217.     THE WCVIEW.VAR @VARIABLE FILE
  218.  
  219.          The WCVIEW.VAR file is a plain ASCII text file which contains
  220.     the replacement text which will be inserted into screens in place of
  221.     the user and system @variables (@TIME@, @BBS@, @USER@, etc.).  The
  222.     original WCVIEW.VAR file supplied with the program contains some
  223.     arbitrary replacement text.  You may very easily customize the file
  224.     to your heart's desire.  You must use a plain ASCII text editor (or
  225.     save the file as straight ASCII text if you are using a word
  226.     processor), to avoid adding unwanted control codes to the file.  In
  227.     addition, there are a few very rigid formatting rules that you must
  228.     follow.
  229.  
  230.     The format for data in this file is as follows:
  231.       1. Each line in the file must begin with an at symbol(@), which
  232.          is the first character in the @variable name.
  233.       2. The 2nd character on the line must be the first character of
  234.          the variable name, which is generally in upper case.
  235.       3. The remainder of the upper case variable name follows,
  236.          immediately terminated with another at symbol(@).
  237.       4. This terminating at symbol (@) is immediately followed by an
  238.          equals sign (=).
  239.       5. The equals sign is immediately followed by the replacement
  240.          text.
  241.       6. The replacement text is immediately followed by the usual
  242.          Carriage Return(CR)/Line Feed(LF) sequence (which is what
  243.          happens when you press the ENTER key to end a line and move on
  244.          to the next line).
  245.       7. There should be no blank lines between the @variable
  246.          definitions.  The files should just be one solid block of
  247.          @xxxx@=yyyyyy lines (see below).
  248.  
  249.       NOTE: any "white space" (spaces) between the equals sign and the
  250.       end of the line (CR/LF) will be included in the replacement text,
  251.       so be sure you press the ENTER key when the cursor is right next
  252.       to the last character you wish to end the text with, without
  253.       pressing the spacebar, tab, or arrow keys first(some text
  254.       editors take the liberty of assuming you meant to enter spaces at
  255.       the end of a line if you use the right arrow key to arrow over a
  256.       few spaces before pressing enter).
  257.  
  258.          This probably sounds a lot more complicated that it actually
  259.     is.  When you look at the default WCVIEW.VAR file, it should be
  260.     immediately obvious what your file should look like. In fact, if you
  261.     just edit this file (or better, a back-up copy of the original
  262.     file), you should be in good shape.  Just delete or type over the
  263.     text you wish to change, and don't add any unwanted spaces at the
  264.     end of the line.
  265.          Here is a brief excerpt from the default WCVIEW.VAR file to
  266.     show you what it should look like:
  267.     
  268.     @BAUD@=9600
  269.     @BBS@=The Coolest BBS
  270.     @BDATE@=02/04/55
  271.     @CALLS@=24
  272.     @COMPANY@=Yardbird Software
  273.     @CONF@=Basket Weaving
  274.     @CPU@=386SX
  275.     @DATE@=11/10/92
  276.  
  277.          The actual variable names and text is up to you.  You can even
  278.     add phony variable names that WILDCAT! would not understand if you
  279.     want to, and WCView will dutifully believe you and insert your
  280.     replacement text into the displays if it comes upon the bogus
  281.     @variable name in a screen file.  This is pointless, of course, but
  282.     this ability is offered just in case Mustang Software adds
  283.     additional @variables in future releases of WILDCAT!  In that event,
  284.     just add them to your WCVIEW.VAR file and you are on you way!
  285.          Along these same lines, the format of the replacement text is
  286.     not checked.  It is up to you to provide valid replacement text.
  287.     For example, dates are displayed in WILDCAT in the MM/DD/YY format,
  288.     if you choose to define the @BDATE@ variable like this:
  289.     
  290.     @BDATE@=March 23rd, Nineteen Ninety Two
  291.  
  292.     you will get what you deserve! (a display which does not match what
  293.     WILDCAT! displays).  But seriously folks, stick to the correct
  294.     format, and then what you see (with WCView) is what you will get
  295.     (with WILDCAT!).
  296.  
  297.  
  298.     GETTING THE LATEST VERSION OF WCVIEW or THE LAUGHING DOG SCREEN MAKER:
  299.  
  300.     To latest versions of WCView or The Laughing Dog Screen Maker can always
  301.     be found on one of the following ASP Hub Network BBS's:
  302.  
  303.     North-East Coast USA           Mid-East Coast USA:
  304.      The Consultant BBS             The Break RBBS <East>
  305.      (718)837-3236                  (703)680-9269
  306.  
  307.     North-Mid USA:                 South Mid-USA:
  308.      The Twilight Zone              The DataExchange BBS
  309.      (715)652-2758                  (318)239-2122
  310.  
  311.     South-West Coast USA:          North-West Coast USA:
  312.      Attention to Details BBS       Space BBS
  313.      (714)681-6221                  (415)323-4398
  314.  
  315.     CANADA:
  316.      Knightec BBS
  317.      (519)940-0007
  318.  
  319.     These BBS's are committed to allowing even first-time callers to download
  320.     AT LEAST one file on their first call, so you can be assured of getting
  321.     the latest version of this program anytime.
  322.  
  323.  
  324.  
  325.     ASP Ombudsman statement
  326.  
  327.         Yardbird Software is a member of the Association of Shareware
  328.     Professionals (ASP).  ASP wants to make sure that the shareware
  329.     principle works for you.  If you are unable to resolve a
  330.     shareware-related problem with an ASP member by contacting the
  331.     member directly, ASP may be able to help.  The ASP Ombudsman can
  332.     help you resolve a dispute or problem with an ASP member, but does
  333.     not provide technical support for members' products.  Please write
  334.     to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442 or
  335.     send a CompuServe message via CompuServe Mail to ASP Ombudsman
  336.     70007,3536.
  337.